home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / X11 / pbmplus / README < prev   
Text File  |  1995-07-14  |  16KB  |  350 lines
  1.                   Extended Portable Bitmap Toolkit
  2.                       Distribution of 10dec91
  3.                    Previous distribution 30oct91
  4.  
  5.  
  6. PBMPLUS is a toolkit for converting various image formats to and from
  7. portable formats, and therefore to and from each other.  The idea is,
  8. if you want to convert among N image formats, you only need 2*N
  9. conversion filters, instead of the N^2 you would need if you wrote each
  10. one separately.
  11.  
  12. In addition to the converters, the package includes some simple tools
  13. for manipulating the portable formats.
  14.  
  15. The package is broken up into four parts.  First is PBM, for bitmaps (1
  16. bit per pixel).  Then there is PGM, for grayscale images.  Next is PPM,
  17. for full-color images.  Last, there is PNM, which does content-independent
  18. manipulations on any of the three internal formats, and also handles
  19. external formats that have multiple types.
  20.  
  21. The parts are upwards compatible: PGM reads both PGM and PBM files and
  22. writes PGM; PPM reads all three and writes PPM; and PNM reads all three
  23. and writes, usually, the same type as it read.  Whenever PNM makes an
  24. exception and "promotes" a file to a higher format, it lets you know.
  25.  
  26.  
  27. INSTALLATION
  28.  
  29.     Unpack the files.
  30.     Decide whether you want to use Imakefiles or Makefiles.  If you want
  31.       to use Makefiles:
  32.  
  33.     Edit the top-level Makefile, find each line with the string
  34.       "CONFIGURE", and follow the directions for setting configuration
  35.       options.
  36.     Likewise edit pbmplus.h.
  37.     If you are using gnu make, you have to edit *all* the Makefiles
  38.       and remove all the imake stuff at the ends, otherwise gnu make
  39.       will overwrite the Makefiles.
  40.     Make.
  41.     When you're happy that things compiled ok, make install.
  42.     
  43.     If you want to use Imakefiles:
  44.  
  45.     Edit Pbmplus.tmpl, find each line with the string "CONFIGURE",
  46.       and follow the directions for setting configuration options.
  47.     Likewise edit pbmplus.h.
  48.     Save the original Makefiles, in case you later want to switch back
  49.       to using them.
  50.     The usual X11 sequence of xmkmf, make Makefiles, make depend, then
  51.       make should work.
  52.     When you're happy that things compiled ok, make install and
  53.       make install.man.
  54.  
  55. After installing the manual pages, you may want to create the "whatis"
  56. file by doing a catman -w -M <directory>, or whatever the equivalent is
  57. on your system.
  58.  
  59.  
  60. SUPPORT
  61.  
  62. I've tested this stuff under SysV and BSD, on Sun 3's 4's and 386's and
  63. Sequents and Vaxen and HPs, with cc and gcc.  Nevertheless, I'm sure bugs
  64. remain, and portability to systems like Amigas and IBM compatibles is
  65. an interesting question.  Feedback is welcome; send bug reports,
  66. enhancements, etc. to this address:
  67.  
  68.     jef@well.sf.ca.us
  69.     apple!well!jef
  70.  
  71. When sending bug reports, always include the output from running any
  72. PBMPLUS program with the -version flag.  Also include the type of
  73. system you are on, what compiler you used, and whether you are using
  74. Makefiles or Imakefiles.  I try to respond to bug reports and enhancements
  75. promptly; say, within a week.
  76.  
  77. Also, if there is a new format or feature you would like to have added
  78. to the package, feel free to drop me a line.  If it's a format, include
  79. whatever documentation you have, and if possible a uuencoded sample.
  80. My response time will depend on how busy I am, and how easy the job
  81. looks.  If you need it right away, or it's a complicated job, you might
  82. consider paying me; lately, that's how a lot of work on the package has
  83. gotten done.
  84.  
  85. Finally, if you have access to Usenet, there's a newsgroup called
  86. alt.graphics.pixutils which is specifically for discussion of image
  87. conversion and editing packages such as PBMPLUS.  Posting stuff there
  88. is even better than mailing it to me, since it lets other people help
  89. out with the answers.
  90.  
  91.  
  92. HOW TO FIND THE RIGHT CONVERTER
  93.  
  94. Some people get confused by all the different names.  If you want to
  95. convert a pbm file to a Sun raster file, is it pbmtorast, pgmtorast,
  96. ppmtorast, or pnmtorast?  In this case some of the confusion might be
  97. because previous versions of the package did in fact have both
  98. pbmtorast and ppmtorast.  But mostly it's just too many different
  99. things to hold in your short term memory.  Fine, so don't even try to
  100. remember what's what.  That's what computers are for.  Unix, at least
  101. BSD Unix, has this great indexing feature on the "man" program.  You
  102. say "man -k <keyword>" and it gives you all the one-line descriptions
  103. with that keyword in them.  All the PBMPLUS man pages have nice useful
  104. one-line descriptions, that mention all the relevant keywords.  Try it,
  105. you'll like it.
  106.  
  107.  
  108. COPYRIGHTS
  109.  
  110. All the software in this package, whether by me or by a contributer,
  111. has a copyright similar to this one:
  112.  
  113.     Permission to use, copy, modify, and distribute this software and its
  114.     documentation for any purpose and without fee is hereby granted, provided
  115.     that the above copyright notice appear in all copies and that both that
  116.     copyright notice and this permission notice appear in supporting
  117.     documentation.  This software is provided "as is" without express or
  118.     implied warranty.
  119.  
  120. Many people get confused by this legalese, especially the part about
  121. "without fee".  Does this mean you can't charge for any product that
  122. uses PBMPLUS?  No.  All it means is that you don't have to pay me.
  123. You can do what you want with this software.  Build it into your
  124. package, steal code from it, whatever.  Just be sure to let people
  125. know where it came from.
  126.  
  127.  
  128. CONTENTS
  129.  
  130. Files in pbmplus.shar:
  131.  
  132.     README        this
  133.     CHANGES        list of changes between the various versions of PBM
  134.     TODO        list of things still to be done
  135.     FORMATS        list of the formats supported
  136.     OTHER.SYSTEMS    list of other free image-processing software
  137.     Makefile        guess
  138.     Imakefile        for X11-type installations
  139.     Imakefile.tiff    for X11-type installations
  140.     Pbmplus.tmpl    for X11-type installations
  141.     pbmplus.h        header file for PBM, PGM, PPM, and PNM
  142.  
  143.     compat.csh        csh script for compatibility with old versions
  144.     compat.ksh        ksh script for compatibility with old versions
  145.     magic        additions for /etc/magic to recognize some image formats
  146.  
  147. Files in pbm.shar?:
  148.  
  149.     Makefile        guess
  150.     Imakefile        for X11-type installations
  151.  
  152.     atktopbm.c        convert Andrew Toolkit raster object to portable bitmap
  153.     brushtopbm.c    convert Xerox doodle brushes to portable bitmap
  154.     cmuwmtopbm.c    convert CMU window manager format to portable bitmap
  155.     g3topbm.c        convert Group 3 FAX to portable bitmap
  156.     icontopbm.c        convert Sun icon to portable bitmap
  157.     gemtopbm.c        convert GEM .img format to portable bitmap
  158.     macptopbm.c        convert MacPaint to portable bitmap
  159.     mgrtopbm.c        convert MGR format to portable bitmap
  160.     pi3topbm.c        convert Atari Degas .pi3 to portable bitmap
  161.     xbmtopbm.c        convert X10 or X11 bitmap to portable bitmap
  162.     ybmtopbm.c        convert Bennet Yee "face" file into portable bitmap
  163.  
  164.     pbmto10x.c        convert portable bitmap to Gemini 10x printer graphics
  165.     pbmtoascii.c    convert portable bitmap to ASCII graphic form
  166.     pbmtoatk.c        convert portable bitmap to Andrew Toolkit raster object
  167.     pbmtobbnbg.c    convert portable bitmap to BBN BitGraph graphics
  168.     pbmtocmuwm.c    convert portable bitmap to CMU window manager format
  169.     pbmtoepson.c    convert portable bitmap to Epson printer graphics
  170.     pbmtog3.c        convert portable bitmap to Group 3 FAX
  171.     pbmtogem.c        convert portable bitmap into GEM .img file
  172.     pbmtogo.c        convert portable bitmap to GraphOn graphics
  173.     pbmtoicon.c        convert portable bitmap to Sun icon
  174.     pbmtolj.c        convert portable bitmap to HP LaserJet graphics
  175.     pbmtomacp.c        convert portable bitmap to MacPaint
  176.     pbmtomgr.c        convert portable bitmap to MGR format
  177.     pbmtopi3.c        convert portable bitmap to Atari Degas .pi3
  178.     pbmtoplot.c        convert portable bitmap into Unix plot(5) file
  179.     pbmtoptx.c        convert portable bitmap to Printronix graphics
  180.     pbmtoxbm.c        convert portable bitmap to X11 bitmap
  181.     pbmtox10bm.c    convert portable bitmap to X10 bitmap
  182.     pbmtoybm.c        convert portable bitmap into Bennet Yee "face" file
  183.     pbmtozinc.c        convert portable bitmap to Zinc Interface Library icon
  184.  
  185.     pbmlife.c        apply Conway's rules of Life to a portable bitmap
  186.     pbmmake.c        create a blank bitmap of a specified size
  187.     pbmmask.c        create a mask bitmap from a regular bitmap
  188.     pbmreduce.c        reduce a portable bitmap N times, using Floyd-Steinberg
  189.     pbmtext.c        render text into a bitmap
  190.     pbmupc.c        create a Universal Product Code bitmap
  191.  
  192.     libpbm[1-5].c    a few utility routines
  193.     pbmmerge.c        merge wrapper routine
  194.     pbm.h        header file for libpbm
  195.     pbmfont.h        header file for font routines in libpbm
  196.     libpbm.h        internal header file for libpbm
  197.     g3.h        definitions for Group 3 FAX
  198.     macp.h        definitions for MacPaint files
  199.     bitreverse.h    useful include file
  200.     *.1            manual entries for all of the tools
  201.     pbm.5        manual entry for the pbm format
  202.     libpbm.3        manual entry for the pbm library
  203.  
  204. Files in pgm.shar?:
  205.  
  206.     Makefile        guess
  207.     Imakefile        for X11-type installations
  208.  
  209.     fitstopgm.c        convert FITS format to portable graymap
  210.     fstopgm.c        convert Usenix FaceSaver(tm) format to portable graymap
  211.     hipstopgm.c        convert HIPS format to portable graymap
  212.     lispmtopgm.c    convert a Lisp Machine bitmap file into pgm format
  213.     psidtopgm.c        convert PostScript "image" data to portable graymap
  214.     rawtopgm.c        convert raw grayscale bytes to portable graymap
  215.  
  216.     pgmtofits.c        convert portable graymap to FITS format
  217.     pgmtofs.c        convert portable graymap to Usenix FaceSaver(tm) format
  218.     pgmtolispm.c    convert a portable graymap into Lisp Machine format
  219.     pgmtopbm.c        convert portable graymap to portable bitmap
  220.  
  221.     pgmbentley.c    Bentleyize a portable graymap
  222.     pgmcrater.c        create cratered terrain by fractal forgery
  223.     pgmedge.c        edge-detect a portable graymap
  224.     pgmenhance.c    edge-enhance a portable graymap
  225.     pgmhist.c        print a histogram of the values in a portable graymap
  226.     pgmnorm.c        normalize contrast in a portable graymap
  227.     pgmoil.c        turn a portable graymap into an oil painting
  228.     pgmramp.c        generate a grayscale ramp
  229.     pgmtexture.c    calculate textural features on a portable graymap
  230.  
  231.     libpgm[1-3].c    a few utility routines
  232.     pgmmerge.c        merge wrapper routine
  233.     pgm.h        header file for libpgm
  234.     libpgm.h        internal header file for libpgm
  235.     dithers.h        useful include file
  236.     *.1            manual entries for all of the tools
  237.     pgm.5        manual entry for the pgm format
  238.     libpgm.3        manual entry for the pgm library
  239.  
  240. Files in ppm.shar?:
  241.  
  242.     Makefile        guess
  243.     Imakefile        for X11-type installations
  244.  
  245.     giftoppm.c        convert GIF to portable pixmap
  246.     gouldtoppm.c    convert Gould scanner file to portable pixmap
  247.     ilbmtoppm.c        convert IFF ILBM to portable pixmap
  248.     imgtoppm.c        convert Img-whatnot to portable pixmap
  249.     mtvtoppm.c        convert MTV ray-tracer output to portable pixmap
  250.     pcxtoppm.c        convert PC Paintbrush format to portable pixmap
  251.     pgmtoppm.c        colorize a portable graymap into a portable pixmap
  252.     pi1toppm.c        convert Atari Degas .pi1 to portable pixmap
  253.     picttoppm.c        convert Macintosh PICT to portable pixmap
  254.     pjtoppm.c        convert HP PaintJet file to portable pixmap
  255.     qrttoppm.c        convert QRT ray-tracer output to portable pixmap
  256.     rawtoppm.c        convert raw RGB bytes to portable pixmap
  257.     rgb3toppm.c        combine three portable graymaps into one portable pixmap
  258.     sldtoppm.c        convert an AutoCAD slide file into a portable pixmap
  259.     spctoppm.c        convert Atari compressed Spectrum to portable pixmap
  260.     sputoppm.c        convert Atari uncompressed Spectrum to portable pixmap
  261.     tgatoppm.c        convert TrueVision Targa file to portable pixmap
  262.     ximtoppm.c        convert Xim to portable pixmap
  263.     xpmtoppm.c        convert XPM format to portable pixmap
  264.     yuvtoppm.c        convert Abekas YUV format to portable pixmap
  265.  
  266.     ppmtoacad.c        convert portable pixmap to AutoCAD database or slide
  267.     ppmtogif.c        convert portable pixmap to GIF
  268.     ppmtoicr.c        convert portable pixmap to NCSA ICR graphics
  269.     ppmtoilbm.c        convert portable pixmap to IFF ILBM
  270.     ppmtopcx.c        convert portable pixmap to PC Paintbrush format
  271.     ppmtopgm.c        convert portable pixmap to portable graymap
  272.     ppmtopi1.c        convert portable pixmap to Atari Degas .pi1
  273.     ppmtopict.c        convert portable pixmap to Macintosh PICT
  274.     ppmtopj.c        convert portable pixmap to HP PaintJet file
  275.     ppmtopuzz.c        convert portable pixmap to X11 "puzzle" file
  276.     ppmtorgb3.c        separate a portable pixmap into three portable graymaps
  277.     ppmtosixel.c    convert portable pixmap to DEC sixel format
  278.     ppmtotga.c        convert portable pixmap to TrueVision Targa file
  279.     ppmtouil.c        convert portable pixmap to Motif UIL icon file
  280.     ppmtoxpm.c        convert portable pixmap to XPM format
  281.     ppmtoyuv.c        convert portable pixmap to Abekas YUV format
  282.  
  283.     ppmdither.c        ordered dither for color images
  284.     ppmforge.c        fractal forgeries of clouds, planets, and starry skies
  285.     ppmhist.c        print a histogram of a portable pixmap
  286.     ppmmake.c        create a pixmap of a specified size and color
  287.     ppmpat.c        create a pretty pixmap
  288.     ppmquant.c        quantize colors down to a specified number
  289.     ppmquantall        script to run ppmquant on a set of pixmaps
  290.     ppmrelief.c        run a Laplacian Relief filter on a portable pixmap
  291.  
  292.     libppm[1-5].c    a few utility routines
  293.     ppmmerge.c        merge wrapper routine
  294.     ppm.h        header file for libppm
  295.     ppmcmap.h        header file for colormap routines in libppm
  296.     ppmdraw.h        header file for simple drawing routines in libppm
  297.     libppm.h        internal header file for libppm
  298.     autocad.h        definitions for AutoCAD files
  299.     tga.h        definitions for TrueVision Targa files
  300.     xim.h        definitions for Xim files
  301.     *.1            manual entries for all of the tools
  302.     ppm.5        manual entry for the ppm format
  303.     libppm.3        manual entry for the ppm library
  304.  
  305. Files in pnm.shar?:
  306.  
  307.     Makefile        guess
  308.     Imakefile        for X11-type installations
  309.  
  310.     anytopnm        script to attempt to convert any format to P?M
  311.     rasttopnm.c        convert Sun raster file to portable anymap
  312.     tifftopnm.c        convert TIFF file to portable anymap
  313.     xwdtopnm.c        convert X10 or X11 window dump to portable anymap
  314.  
  315.     pnmtops.c        convert portable anymap to PostScript
  316.     pnmtorast.c        convert portable anymap to Sun raster file
  317.     pnmtotiff.c        convert portable anymap to TIFF file
  318.     pnmtoxwd.c        convert portable anymap to X11 window dump
  319.  
  320.     pnmarith.c        perform arithmetic on two portable anymaps
  321.     pnmcat.c        concatenate portable anymaps
  322.     pnmconvol.c        general MxN convolution on a portable anymap
  323.     pnmcrop.c        crop all like-colored borders off a portable anymap
  324.     pnmcut.c        select a rectangular region from a portable anymap
  325.     pnmdepth.c        change the maxval in a portable anymap
  326.     pnmenlarge.c    enlarge a portable anymap N times
  327.     pnmfile.c        describe a portable anymap
  328.     pnmflip.c        perform one or more flip operations on a portable anymap
  329.     pnmgamma.c        perform gamma correction on a portable anymap
  330.     pnmindex        script to build a visual index of a bunch of anymaps
  331.     pnminvert.c        invert a portable anymap
  332.     pnmmargin        script to add a margin to a portable anymap
  333.     pnmnoraw.c        force a portable anymap into ASCII format
  334.     pnmpaste.c        paste a rectangle into a portable anymap
  335.     pnmrotate.c        rotate a portable anymap
  336.     pnmscale.c        scale a portable anymap
  337.     pnmshear.c        shear a portable anymap
  338.     pnmsmooth        script that uses pnmconvol to smooth a anymap
  339.     pnmtile.c        replicate a portable anymap into a specified size
  340.  
  341.     libpnm[1-4].c    a few utility routines
  342.     pnmmerge.c        merge wrapper routine
  343.     pnm.h        header file for libpnm
  344.     rast.h        definitions for Sun raster files
  345.     x10wd.h        definitions for X10 window dumps
  346.     x11wd.h        definitions for X11 window dumps
  347.     *.1            manual entries for all of the tools
  348.     pnm.5        manual entry for the pnm format
  349.     libpnm.3        manual entry for the pnm library
  350.